API Documentation
Static Public Member Functions | List of all members
nkAstraeus::lua::nkGraphicsWrap::RenderQueueManagerWrapper Class Referencefinal

Wraps the nkGraphics::RenderQueueManager and offers functions for use in scripting. More...

Static Public Member Functions

static void updateEnvironment (nkScripts::Environment *env)
 
static nkScripts::OutputValue createOrRetrieveIndex (const nkScripts::DataStack &stack)
 
static nkScripts::OutputValue createOrRetrieveName (const nkScripts::DataStack &stack)
 
static nkScripts::OutputValue getName (const nkScripts::DataStack &stack)
 
static nkScripts::OutputValue getIndex (const nkScripts::DataStack &stack)
 

Detailed Description

Wraps the nkGraphics::RenderQueueManager and offers functions for use in scripting.

Member Function Documentation

◆ updateEnvironment()

static void nkAstraeus::lua::nkGraphicsWrap::RenderQueueManagerWrapper::updateEnvironment ( nkScripts::Environment env)
static

Updates a given environment and set it up to use all functions wrapped by this wrapper.

Parameters
envThe environment to set up.

◆ createOrRetrieveIndex()

static nkScripts::OutputValue nkAstraeus::lua::nkGraphicsWrap::RenderQueueManagerWrapper::createOrRetrieveIndex ( const nkScripts::DataStack stack)
static

Wrapper function for nkGraphics::RenderQueueManager::createOrRetrieve(), with index.

local rq = nkGraphics.RenderQueueManager.createOrRetrieveIndex(0) ;
Parameters
stackThe parameter stack.
Returns
The output value, as a nkGraphics::RenderQueue.

◆ createOrRetrieveName()

static nkScripts::OutputValue nkAstraeus::lua::nkGraphicsWrap::RenderQueueManagerWrapper::createOrRetrieveName ( const nkScripts::DataStack stack)
static

Wrapper function for nkGraphics::RenderQueueManager::createOrRetrieve(), with name.

local rq = nkGraphics.RenderQueueManager.createOrRetrieveName("Hey") ;
Parameters
stackThe parameter stack.
Returns
The output value, as a nkGraphics::RenderQueue.

◆ getName()

static nkScripts::OutputValue nkAstraeus::lua::nkGraphicsWrap::RenderQueueManagerWrapper::getName ( const nkScripts::DataStack stack)
static

Wrapper function for nkGraphics::RenderQueueManager::get(), with name.

local rq = nkGraphics.RenderQueueManager.getName("Hey") ;
Parameters
stackThe parameter stack.
Returns
The output value, as a nkGraphics::RenderQueue.

◆ getIndex()

static nkScripts::OutputValue nkAstraeus::lua::nkGraphicsWrap::RenderQueueManagerWrapper::getIndex ( const nkScripts::DataStack stack)
static

Wrapper function for nkGraphics::RenderQueueManager::get(), with index.

local rq = nkGraphics.RenderQueueManager.getIndex(0) ;
Parameters
stackThe parameter stack.
Returns
The output value, as a nkGraphics::RenderQueue.

The documentation for this class was generated from the following file: